home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / viewers / grasp / glib.man < prev    next >
Text File  |  1995-02-13  |  8KB  |  218 lines
  1.  
  2.  
  3.  
  4.     GLIB 2.1                                                  02.09.92
  5.  
  6.  
  7.  
  8.     ABOUT
  9.  
  10.     GLIB is a GRASP file librarian. It can extract files from a GRASP
  11.     archive, add files, delete, and can be used to create archives
  12.     that are in an Amiga friendly format. This program requires KS2.0
  13.     to run.
  14.  
  15.     GLIB is one of the four programs in the GL 2.1 distribution. The
  16.     others are the player GL, the .PIC/.CLP converter PIC2HL, and the
  17.     font extracter GLFONT.
  18.  
  19.     GLIB is Copyright © 1992 by John Bickers.
  20.  
  21.  
  22.     USAGE
  23.  
  24.     GLIB requires the iff.library and the pattern.library. The
  25.     xpkmaster.library may also be required for some existing Amiga
  26.     files, and is strongly recommended in any case.
  27.  
  28.     The interface to this program is meant to be like an archiver's,
  29.     so it has a format like:
  30.  
  31.         "glib <switches> <command> <archive name> <file list>"
  32.  
  33.     Typing "glib ?" will display a summary of the switches and commands
  34.     available. This output looks like:
  35.  
  36. > USAGE: glib [-switches] [command] {GL file} [filelist]
  37. >    switches: -hnum     Allow for num header records.
  38. >              -iname    Use name as input file prefix.
  39. >              -oname    Use name as output file prefix.
  40. >              -p        Create a PClone archive (use with 'a' command).
  41. >              -tname    Use name as temp directory prefix.
  42. >              -xmethod  Use method for xpk compression.
  43. >    command:  a[!]      Add [overwrite].
  44. >              d         Delete.
  45. >              l,v       List contents.
  46. >              e,x       Extract.
  47. >    filelist: a list of filenames. A name preceded by an '@' is assumed to
  48. >              contain a list of files itself.
  49.  
  50.  
  51.     SWITCHES
  52.  
  53.     -hnum   A buffer is allocated with one entry for each file that
  54.             can be in a GL. The default size is 128. If you have a GL
  55.             with more than 128 files in it, use this switch to
  56.             increase the buffer size.
  57.  
  58.     -iname  This option affects the 'a' command. When a file is being
  59.             added, it's name is checked for ':' and '/' characters. If
  60.             there are none, then any prefix specified with the -i
  61.             switch is prepended to the filename, with a '/' if
  62.             necessary.
  63.  
  64.             For example, if you wanted to add all the .PIC and .CLP
  65.             files in gfx:pictures/1 to the GL file ram:test.GL, you
  66.             could type:
  67.  
  68.             3> glib -igfx:pictures/1 a ram:test #?.PIC #?.CLP
  69.  
  70.     -oname  This option affects the 'e' and 'x' commands. All
  71.             extracted files will be saved into the directory specified
  72.             by "name".
  73.  
  74.             For example, to extract all the .PIC files in ram:test.GL
  75.             to ram:, you could type:
  76.  
  77.             3> glib -oram: x ram:test.GL #?.PIC
  78.  
  79.     -p      When used with the "a" command to create a new archive,
  80.             this option creates a PClone format file. A PClone file
  81.             does not have the Amiga ID in the first 4 bytes, and has
  82.             numbers stored in Intel rather than Motorola order.
  83.  
  84.     -tname  When adding or extracting files, a temporary copy of the
  85.             GL file is made. This switch lets you indicate where you
  86.             want this to happen. The default temporary directory is
  87.             "t:".
  88.  
  89.             You can save yourself a final copy from the temp file to
  90.             the target archive name if you set this to be on the same
  91.             volume that the target archive name is on.
  92.  
  93.     -xmethod
  94.             Define the xpk compression method to use. Decompression
  95.             automatically knows which method to use, but when adding
  96.             files you can choose a method using this switch. If you
  97.             don't use this switch, no compression is performed.
  98.  
  99.             Because it has a good compression ratio and a fast
  100.             decompression speed, NUKE is probably the best choice for
  101.             archives that you distribute.
  102.  
  103.  
  104.     COMMANDS
  105.  
  106.     a[!]    The add command, with an optional "override" parameter.
  107.             The files listed in the arguments are added to the
  108.             archive. Any path prefix is removed from the filename
  109.             when it is stored.
  110.  
  111.             If a file already exists in the archive, it will be
  112.             skipped, unless you add the ! character to the command.
  113.             For example, if you want to overwrite the file anim.txt
  114.             in anim.GL, you can type:
  115.  
  116.             3> glib a! anim.GL anim.txt
  117.  
  118.             The new files are added to the archive header, then the
  119.             archive is written out again. If all is successful, the
  120.             old archive will be deleted (if there was one) and the new
  121.             archive will take its place.
  122.  
  123.             If this is an Amiga archive, ILBM files being added will
  124.             be converted to a raw form then compressed using the xpk
  125.             libraries.
  126.  
  127.     d       The delete command. The filenames on the command line will
  128.             be deleted from the archive.
  129.  
  130.             Matching filenames are removed from the archive header,
  131.             and the archive is written out. If all is successful, the
  132.             old archive will be deleted and the new archive will take
  133.             its place.
  134.  
  135.     l,v     The list command. This lists the names and positions of
  136.             the files in the archive.
  137.  
  138.     e,x     The extract command. The filenames on the command line
  139.             will be extracted. If you used the -o switch, they will be
  140.             saved to the directory you specified there. Otherwise they
  141.             are saved to the current directory.
  142.  
  143.             If this is an Amiga archive, raw picture data will be
  144.             saved out as IFF ILBMs. The w (width) field in the BMHD
  145.             chunk of the file will be the same as the width used by
  146.             the player. DPaint will use this width if you load the
  147.             picture as a brush, but will NOT use it if you load the
  148.             picture normally. Instead, it uses a width that divides
  149.             evenly by 16. Mostra does this too.
  150.  
  151.  
  152.     FILE LIST
  153.  
  154.     Arguments following the command and the archive name that do not
  155.     start with a '-' character are treated as filenames. Wildcard
  156.     expansion is performed for all commands.
  157.  
  158.     When a filename starts with '@', it is treated as a special case.
  159.     The file is opened, and each line in the file is treated as a
  160.     filename. The process is not recursive - if a filename WITHIN an
  161.     @ file starts with a '@', it is not treated especially. Within
  162.     the file, leading blanks are removed, and blank lines and lines
  163.     starting with '#' are ignored.
  164.  
  165.     @ can be used to read filenames from the console, by using @* as
  166.     an argument. For example:
  167.  
  168.     3> glib a ram:test.GL @*
  169.  
  170.     Hit Ctrl-\ to terminate the input. Note that this does NOT work
  171.     at the end of a pipe.
  172.  
  173.  
  174.     CREDITS
  175.  
  176.     GLIB is written by John Bickers using SAS C 5.10a.
  177.  
  178.     GRASP is a product of Microtex Industries, Inc. It's a sort of
  179.     slideshow animation program on PClones.
  180.  
  181.     Christian A. Weber's iff.library is used for loading and saving
  182.     ILBM files.
  183.  
  184.     Pattern matching is done through pattern.library, which is
  185.     Copyright (c) Angela Schmidt.
  186.  
  187.     The xpkmaster.library and sublibraries are the work of U. Dominik
  188.     Mueller and crew. The BLZW method, which I first saw in the form
  189.     of compress.library, is the reason I thought about using a
  190.     library to do compression.
  191.  
  192.  
  193.     DISTRIBUTION
  194.  
  195.     GLIB is Copyright © 1992 by John Bickers.
  196.  
  197.     Distribution is via normal channels. That is, distribute it for
  198.     free, or for Fred Fish like costs, but not more. And remember to
  199.     include the documentation.
  200.  
  201.  
  202.     CONTACT INFO
  203.  
  204.     If you have suggestions or problems, or want to move data, I can
  205.     be reached at:
  206.  
  207.         John Bickers
  208.         214 Rata St
  209.         Naenae 6301
  210.         New Zealand
  211.  
  212.     Or: jbickers@templar.actrix.gen.nz
  213.  
  214.  
  215.     DISCLAIMER
  216.  
  217.     It works on my machine.
  218.